Skip to content

Conversation

@skfegan
Copy link
Member

@skfegan skfegan commented Aug 22, 2025

Summary

This pull request is to bring in the documentation for version 1.0

Changes

Change 1 Documentation

  • Updated documentation for the code input parameters
  • Added a science section describing the underlying theory
  • Included examples in the Quick Start section

Impact

  • These changes will increase the user friendliness of CodeEntropy

@jkalayan
Copy link
Collaborator

nbsphinx should be added to docs requirements

@harryswift01 harryswift01 changed the title 43 version 1 documentation Update Documentation for v1.0 Release Candidate of CodeEntropy Aug 22, 2025
@harryswift01 harryswift01 added this to the 1.0.0 release milestone Aug 22, 2025
@harryswift01 harryswift01 added the documentation Improvements or additions to documentation label Aug 22, 2025
@skfegan skfegan merged commit f3bb8b0 into main Aug 22, 2025
7 checks passed
@skfegan skfegan deleted the 43-version-1-documentation branch August 22, 2025 16:19
jimboid pushed a commit that referenced this pull request Sep 3, 2025
Update Documentation for `v1.0` Release Candidate of `CodeEntropy`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Examples Version 1.0 Documentation Make it clear on how to setup the simulation

5 participants